-
Notifications
You must be signed in to change notification settings - Fork 5.1k
Fixed TestAssetsFromDir unit test failure on Windows #21742
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Fixed TestAssetsFromDir unit test failure on Windows #21742
Conversation
bobsira
commented
Oct 13, 2025
- Added a t.Cleanup hook that iterates over every CopyableFile returned by assetsFromDir and calls Close(). This releases the open file descriptors created by assets.NewFileAsset.
- This directly fixes the Windows test failure where RemoveAll couldn’t delete temp files because they were still open.
- Switched some non-fatal t.Errorf + return cases to t.Fatalf for earlier, clearer abort when setup fails (creating test files or gathering assets).
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: bobsira The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
Hi @bobsira. Thanks for your PR. I'm waiting for a kubernetes member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
|
Can one of the admins verify this patch? |
nirs
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Too much changes, It think only one is needed to fix the windows build. Can we focus only on fixing the windows build and defer other changes for later?
| } | ||
|
|
||
| // Ensure file descriptors opened by assets.NewFileAsset are released (critical on Windows). | ||
| t.Cleanup(func() { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This must be called before calling assetsFromDir().
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please clarify more on this because the current placement looks fine to me since:
- assetsFromDir opens the files (via assets.NewFileAsset) and returns []assets.CopyableFile. We don’t have anything to close until you have that slice.
- We register t.Cleanup immediately after obtaining actualFiles. That’s the earliest possible point we can close them reliably.
- t.Cleanup runs after the subtest finishes (even if it fails), so descriptors are released in all cases.
- Moving the cleanup registration “before” the call would be impossible (the slice doesn’t exist yet) unless we refactored assetsFromDir to accept a callback, which is unnecessary for a test.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So if assetsFromDir fails, we don't have anything to cleanup? Can return incomplete results and fail?
If it either return slice or fail without opening anything we are fine with current code. If it can open some files and fail, we can either clean up in assetsFromDir, or here by registring the cleanup before we call:
var actualFiles []Xxx
t.Cleanup(...)
actualFiles = ...
But it will probably better to cleanup in assetsFromDir() or a test helper using it. Test helpers should get a t *testing.T argument and handle cleanup and test failures internally so the test code is simpler.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I introduced a collectAssets(t, root, dest, flatten) test helper that:
- Calls assetsFromDir once and immediately registers a t.Cleanup to close any FileAsset descriptors it opened (including partial slices if the walk fails).
- Keeps error handling + cleanup localized so each subtest only sets up files and validates the mapping. This addresses the earlier concern about calling cleanup “early enough” without modifying production code. Moving cleanup into assetsFromDir would change its resource lifecycle semantics for other callers, so keeping it in a test helper preserves current behavior while preventing leaks on Windows. Let me know if you’d prefer an additional error-path test; happy to add one if we can deterministically trigger a walk failure.
| t.Helper() | ||
| files, err := assetsFromDir(root, dest, flatten) | ||
|
|
||
| t.Cleanup(func() { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @msft-linliu , investigating moving t.Cleanup, yes we can move t.Cleanup earlier, but the practical benefit is very small. Right now cleanup is already registered before we branch on err, so opened assets are closed even when assetsFromDir returns an error. Moving it “further up” only helps in the very narrow case where we want the cleanup registered before a potential panic inside assetsFromDir. If that function panics before returning, we still won’t have access to any partially created assets to close; the slice would remain empty. So this is mostly a stylistic change.
The moved-up version would look like this
func collectAssets(t *testing.T, root, dest string, flatten bool) []assets.CopyableFile {
t.Helper()
files := []assets.CopyableFile{} // declare first so closure captures it
t.Cleanup(func() {
for _, f := range files {
if cerr := f.Close(); cerr != nil {
t.Logf("warning: closing asset %s failed: %v", f.GetSourcePath(), cerr)
}
}
})
// now populate files
fs, err := assetsFromDir(root, dest, flatten)
files = fs
if err != nil {
t.Fatalf("assetsFromDir(%q, %q, flatten=%v) unexpected error: %v", root, dest, flatten, err)
}
return files
}